Notification Webhook

Business needs to provide the endpoint URL where the notifications of Message status will be sent.

API Endpoint

Provided by the business

Authentication Methods Supported

Both Basic and Bearer Token methods are supported. If Basic method is chosen, business needs to set the username and password. In case of Bearer method, the corresponding token will be configured by the business.

Status Callback Payloads

1. Sent Status Callback

{
  "messageId": "wamid.HBgMOTE5NjY4NDEyMDY4FQIAERgSREEwQkYxNjIxMTk5ODRDNddzAA==",
  "messageRef": "aa_cta",
  "subscriberId": "919672242292",
  "status": "sent",
  "sentAt": 1788939562
}

2. Delivered Status Callback

{
  "messageId": "wamid.HBgMOTE5NjY4NDEyMDY4FQIAERgSREEwQkYxNjIxMTk5ODRDNddzAA==",
  "messageRef": "aa_cta",
  "subscriberId": "919672242292",
  "status": "delivered",
  "deliveredAt": 1788939562
}

3. Read Status Callback

{
  "messageId": "wamid.HBgMOTE5NjY4NDEyMDY4FQIAERgSREEwQkYxNjIxMTk5ODRDNddzAA==",
  "messageRef": "aa_cta",
  "subscriberId": "919672242292",
  "status": "read",
  "readAt": 1788939562
}

4. Failed Status Callback

{
  "messageId": "wamid.HBgMOTE5NjY4NDEyMDY4FQIAERgSREEwQkYxNjIxMTk5ODRDNddzAA==",
  "messageRef": "aa_cta",
  "subscriberId": "919672242292",
  "status": "failed",
  "failedAt": 1788939562,
  "failureReason": "Message failed to send because more than 24 hours have passed since the customer last replied to this number.",
  "failureDetails": "Message failed to send because more than 24 hours have passed since the customer last replied to this number.",
  "errorCode": 131047
}

Properties

Field	Type	Description
`messageId`	`string`	Unique identifier for the message
`messageRef`	`string`	Reference ID / tag assigned to the message
`subscriberId`	`string`	Destination phone number
`status`	`string`	Status of the message (`sent`, `delivered`, `read`, `failed`)
`sentAt`	`number`	Epoch timestamp when message was sent
`deliveredAt`	`number`	Epoch timestamp when message was delivered
`readAt`	`number`	Epoch timestamp when message was read
`failedAt`	`number`	Epoch timestamp when delivery failed
`failureReason`	`string`	Brief reason for message failure
`failureDetails`	`string`	Detailed explanation of the failure
`errorCode`	`number`	Numerical error code

Response

HTTP Status Code: 200 OK (successful), 4xx/5xx (error)

API Endpoint​

Authentication Methods Supported​

Status Callback Payloads​

1. Sent Status Callback​

2. Delivered Status Callback​

3. Read Status Callback​

4. Failed Status Callback​

Properties​

Response​